home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Xm / XmMainWindow.z / XmMainWindow
Encoding:
Text File  |  2002-10-03  |  22.7 KB  |  331 lines

  1.  
  2.  
  3.  
  4.      XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwww((((3333XXXX))))          UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV          XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwww((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwww - The MainWindow widget class
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           #include <Xm/MainW.h>
  13.  
  14.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  15.           This page documents Motif 2.1.
  16.  
  17.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.           MainWindow provides a standard layout for the primary window
  19.           of an application. This layout includes a MenuBar, a
  20.           CommandWindow, a work region, a MessageWindow, and
  21.           ScrollBars. Any or all of these areas are optional. The work
  22.           region and ScrollBars in the MainWindow behave identically
  23.           to the work region and ScrollBars in the ScrolledWindow
  24.           widget. The user can think of the MainWindow as an extended
  25.           ScrolledWindow with an optional MenuBar and optional
  26.           CommandWindow and MessageWindow.
  27.  
  28.           In a fully loaded MainWindow, the MenuBar spans the top of
  29.           the window horizontally. The CommandWindow spans the
  30.           MainWindow horizontally just below the MenuBar, and the work
  31.           region lies below the CommandWindow.  The MessageWindow is
  32.           below the work region.  Any space remaining below the
  33.           MessageWindow is managed in a manner identical to
  34.           ScrolledWindow.  The behavior of ScrolledWindow can be
  35.           controlled by the ScrolledWindow resources.  To create a
  36.           MainWindow, first create the work region elements, a
  37.           MenuBar, a CommandWindow, a MessageWindow, a horizontal
  38.           ScrollBar, and a vertical ScrollBar widget, and then call
  39.           XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwwwSSSSeeeettttAAAArrrreeeeaaaassss with those widget IDs.
  40.  
  41.           MainWindow can also create three Separator widgets that
  42.           provide a visual separation of MainWindow's four components.
  43.           The user can specify resources in a resource file for the
  44.           automatically created gadgets that contain the MainWindow
  45.           separators. The name of the first separator gadget is
  46.           SSSSeeeeppppaaaarrrraaaattttoooorrrr1111; the second is SSSSeeeeppppaaaarrrraaaattttoooorrrr2222; and the third is
  47.           SSSSeeeeppppaaaarrrraaaattttoooorrrr3333.
  48.  
  49.           MainWindow also provides the following three child types for
  50.           layout at creation time:
  51.  
  52.              +o  XXXXmmmmMMMMEEEENNNNUUUU____BBBBAAAARRRR
  53.  
  54.              +o  XXXXmmmmCCCCOOOOMMMMMMMMAAAANNNNDDDD____WWWWIIIINNNNDDDDOOOOWWWW
  55.  
  56.              +o  XXXXmmmmMMMMEEEESSSSSSSSAAAAGGGGEEEE____WWWWIIIINNNNDDDDOOOOWWWW
  57.  
  58.           MainWindow can use these child types at creation time
  59.           instead of their associated resource values.  MainWindow
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwww((((3333XXXX))))          UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV          XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwww((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           uses the _X_m_Q_T_m_e_n_u_S_y_s_t_e_m trait.
  75.  
  76.         DDDDeeeesssscccceeeennnnddddaaaannnnttttssss
  77.           MainWindow automatically creates the descendants shown in
  78.           the following table.  An application can use XXXXttttNNNNaaaammmmeeeeTTTTooooWWWWiiiiddddggggeeeetttt
  79.           to gain access to the named descendant. In addition, a user
  80.           or an application can use the named descendant when
  81.           specifying resource values.
  82.           NNNNaaaammmmeeeedddd DDDDeeeesssscccceeeennnnddddaaaannnntttt   CCCCllllaaaassssssss               IIIIddddeeeennnnttttiiiittttyyyy
  83.           ________________________________________________________________________________________________________________________________
  84.           HHHHoooorrrrSSSSccccrrrroooollllllllBBBBaaaarrrr       XXXXmmmmSSSSccccrrrroooollllllllBBBBaaaarrrr         horizontal scroll bar
  85.           SSSSeeeeppppaaaarrrraaaattttoooorrrr1111         XXXXmmmmSSSSeeeeppppaaaarrrraaaattttoooorrrrGGGGaaaaddddggggeeeetttt   optional first separator
  86.           SSSSeeeeppppaaaarrrraaaattttoooorrrr2222         XXXXmmmmSSSSeeeeppppaaaarrrraaaattttoooorrrrGGGGaaaaddddggggeeeetttt   optional second separator
  87.           SSSSeeeeppppaaaarrrraaaattttoooorrrr3333         XXXXmmmmSSSSeeeeppppaaaarrrraaaattttoooorrrrGGGGaaaaddddggggeeeetttt   optional third separator
  88.           VVVVeeeerrrrttttSSSSccccrrrroooollllllllBBBBaaaarrrr      XXXXmmmmSSSSccccrrrroooollllllllBBBBaaaarrrr         vertical scroll bar
  89.  
  90.         CCCCllllaaaasssssssseeeessss
  91.           MainWindow inherits behavior and resources from CCCCoooorrrreeee,
  92.           CCCCoooommmmppppoooossssiiiitttteeee, CCCCoooonnnnssssttttrrrraaaaiiiinnnntttt, XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr, and XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww.
  93.  
  94.           The class pointer is _x_m_M_a_i_n_W_i_n_d_o_w_W_i_d_g_e_t_C_l_a_s_s.
  95.  
  96.           The class name is XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwww.
  97.  
  98.         NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  99.           The following table defines a set of widget resources used
  100.           by the programmer to specify data. The programmer can also
  101.           set the resource values for the inherited classes to set
  102.           attributes for this widget. To reference a resource by name
  103.           or by class in a ....XXXXddddeeeeffffaaaauuuullllttttssss file, remove the XXXXmmmmNNNN or XXXXmmmmCCCC
  104.           prefix and use the remaining letters. To specify one of the
  105.           defined values for a resource in a ....XXXXddddeeeeffffaaaauuuullllttttssss file, remove
  106.           the XXXXmmmm prefix and use the remaining letters (in either
  107.           lowercase or uppercase, but include any underscores between
  108.           words).  The codes in the access column indicate if the
  109.           given resource can be set at creation time (C), set by using
  110.           XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (S), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (G), or is
  111.           not applicable (N/A).
  112.  
  113.                                               XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwww RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  114.           NNNNaaaammmmeeee                        CCCCllllaaaassssssss                       TTTTyyyyppppeeee            DDDDeeeeffffaaaauuuulllltttt            AAAAcccccccceeeessssssss
  115.           XmNcommandWindow            XmCCommandWindow            Widget          NULL               CSG
  116.           XmNcommandWindowLocation    XmCCommandWindowLocation    unsigned char   ABOVE (SeeDesc.)   CG
  117.           XmNmainWindowMarginHeight   XmCMainWindowMarginHeight   Dimension       0                  CSG
  118.           XmNmainWindowMarginWidth    XmCMainWindowMarginWidth    Dimension       0                  CSG
  119.           XmNmenuBar                  XmCMenuBar                  Widget          NULL               CSG
  120.           XmNmessageWindow            XmCMessageWindow            Widget          NULL               CSG
  121.           XmNshowSeparator            XmCShowSeparator            Boolean         False              CSG
  122.  
  123.           XXXXmmmmNNNNccccoooommmmmmmmaaaannnnddddWWWWiiiinnnnddddoooowwww
  124.                     Specifies the widget to be laid out as the
  125.                     CommandWindow. This widget must have been
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwww((((3333XXXX))))          UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV          XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwww((((3333XXXX))))
  137.  
  138.  
  139.  
  140.                     previously created and managed as a child of
  141.                     MainWindow.
  142.  
  143.           XXXXmmmmNNNNccccoooommmmmmmmaaaannnnddddWWWWiiiinnnnddddoooowwwwLLLLooooccccaaaattttiiiioooonnnn
  144.                     Controls the position of the command window.
  145.                     XXXXmmmmCCCCOOOOMMMMMMMMAAAANNNNDDDD____AAAABBBBOOOOVVVVEEEE____WWWWOOOORRRRKKKKSSSSPPPPAAAACCCCEEEElocates the command
  146.                     window between the menu bar and the work window.
  147.                     XXXXmmmmCCCCOOOOMMMMMMMMAAAANNNNDDDD____BBBBEEEELLLLOOOOWWWW____WWWWOOOORRRRKKKKSSSSPPPPAAAACCCCEEEE locates the command
  148.                     window between the work window and the message
  149.                     window.
  150.  
  151.           XXXXmmmmNNNNmmmmaaaaiiiinnnnWWWWiiiinnnnddddoooowwwwMMMMaaaarrrrggggiiiinnnnHHHHeeeeiiiigggghhhhtttt
  152.                     Specifies the margin height on the top and bottom
  153.                     of MainWindow. This resource overrides any setting
  154.                     of the ScrolledWindow resource
  155.                     XXXXmmmmNNNNssssccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwwwMMMMaaaarrrrggggiiiinnnnHHHHeeeeiiiigggghhhhtttt.
  156.  
  157.           XXXXmmmmNNNNmmmmaaaaiiiinnnnWWWWiiiinnnnddddoooowwwwMMMMaaaarrrrggggiiiinnnnWWWWiiiiddddtttthhhh
  158.                     Specifies the margin width on the right and left
  159.                     sides of MainWindow. This resource overrides any
  160.                     setting of the ScrolledWindow resource
  161.                     XXXXmmmmNNNNssssccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwwwMMMMaaaarrrrggggiiiinnnnWWWWiiiiddddtttthhhh.
  162.  
  163.           XXXXmmmmNNNNmmmmeeeennnnuuuuBBBBaaaarrrr
  164.                     Specifies the widget to be laid out as the
  165.                     MenuBar. This widget must have been previously
  166.                     created and managed as a child of MainWindow.
  167.  
  168.           XXXXmmmmNNNNmmmmeeeessssssssaaaaggggeeeeWWWWiiiinnnnddddoooowwww
  169.                     Specifies the widget to be laid out as the
  170.                     MessageWindow. This widget must have been
  171.                     previously created and managed as a child of
  172.                     MainWindow.  The MessageWindow is positioned at
  173.                     the bottom of the MainWindow.  If this value is
  174.                     NULL, no message window is included in the
  175.                     MainWindow.
  176.  
  177.           XXXXmmmmNNNNsssshhhhoooowwwwSSSSeeeeppppaaaarrrraaaattttoooorrrr
  178.                     Displays separators between the components of the
  179.                     MainWindow when set to True. If set to False, no
  180.                     separators are displayed.
  181.  
  182.         IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
  183.           MainWindow inherits behavior and resources from the
  184.           superclasses described in the following table.  For a
  185.           complete description of each resource, refer to the
  186.           reference page for that superclass.
  187.  
  188.                                                    XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  189.           NNNNaaaammmmeeee                            CCCCllllaaaassssssss                           TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt                 AAAAcccccccceeeessssssss
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 10/3/02)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwww((((3333XXXX))))          UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV          XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwww((((3333XXXX))))
  203.  
  204.  
  205.  
  206.           XmNautoDragModel                XmCAutoDragModel                XtEnum           XmAUTO_DRAG_ENABLED     CSG
  207.           XmNclipWindow                   XmCClipWindow                   Widget           dynamic                 G
  208.           XmNhorizontalScrollBar          XmCHorizontalScrollBar          Widget           dynamic                 CSG
  209.           XmNscrollBarDisplayPolicy       XmCScrollBarDisplayPolicy       unsigned char    dynamic                 CSG
  210.           XmNscrollBarPlacement           XmCScrollBarPlacement           unsigned char    XmBOTTOM_RIGHT          CSG
  211.           XmNscrolledWindowMarginHeight   XmCScrolledWindowMarginHeight   Dimension        0                       N/A
  212.           XmNscrolledWindowMarginWidth    XmCScrolledWindowMarginWidth    Dimension        0                       N/A
  213.           XmNscrollingPolicy              XmCScrollingPolicy              unsigned char    XmAPPLICATION_DEFINED   CG
  214.           XmNspacing                      XmCSpacing                      Dimension        4                       CSG
  215.           XmNtraverseObscuredCallback     XmCCallback                     XtCallbackList   NULL                    CSG
  216.           XmNverticalScrollBar            XmCVerticalScrollBar            Widget           dynamic                 CSG
  217.           XmNvisualPolicy                 XmCVisualPolicy                 unsigned char    dynamic                 G
  218.           XmNworkWindow                   XmCWorkWindow                   Widget           NULL                    CSG
  219.  
  220.                                                 XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  221.           NNNNaaaammmmeeee                      CCCCllllaaaassssssss                   TTTTyyyyppppeeee                DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  222.           XmNbottomShadowColor      XmCBottomShadowColor    Pixel               dynamic                CSG
  223.           XmNbottomShadowPixmap     XmCBottomShadowPixmap   Pixmap              XmUNSPECIFIED_PIXMAP   CSG
  224.           XmNforeground             XmCForeground           Pixel               dynamic                CSG
  225.           XmNhelpCallback           XmCCallback             XtCallbackList      NULL                   C
  226.           XmNhighlightColor         XmCHighlightColor       Pixel               dynamic                CSG
  227.           XmNhighlightPixmap        XmCHighlightPixmap      Pixmap              dynamic                CSG
  228.           XmNinitialFocus           XmCInitialFocus         Widget              NULL                   CSG
  229.           XmNlayoutDirection        XmCLayoutDirection      XmDirection         dynamic                CG
  230.           XmNnavigationType         XmCNavigationType       XmNavigationType    XmTAB_GROUP            CSG
  231.           XmNpopupHandlerCallback   XmCCallback             XtCallbackList      NULL                   C
  232.           XmNshadowThickness        XmCShadowThickness      Dimension           0                      CSG
  233.           XmNstringDirection        XmCStringDirection      XmStringDirection   dynamic                CG
  234.           XmNtopShadowColor         XmCTopShadowColor       Pixel               dynamic                CSG
  235.           XmNtopShadowPixmap        XmCTopShadowPixmap      Pixmap              dynamic                CSG
  236.           XmNtraversalOn            XmCTraversalOn          Boolean             True                   CSG
  237.           XmNunitType               XmCUnitType             unsigned char       dynamic                CSG
  238.           XmNuserData               XmCUserData             XtPointer           NULL                   CSG
  239.  
  240.                                   CCCCoooommmmppppoooossssiiiitttteeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  241.           NNNNaaaammmmeeee                CCCCllllaaaassssssss               TTTTyyyyppppeeee          DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  242.           XmNchildren         XmCReadOnly         WidgetList    NULL      G
  243.           XmNinsertPosition   XmCInsertPosition   XtOrderProc   NULL      CSG
  244.           XmNnumChildren      XmCReadOnly         Cardinal      0         G
  245.  
  246.                                                         CCCCoooorrrreeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  247.           NNNNaaaammmmeeee                            CCCCllllaaaassssssss                           TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  248.           XmNaccelerators                 XmCAccelerators                 XtAccelerators   dynamic                CSG
  249.           XmNancestorSensitive            XmCSensitive                    Boolean          dynamic                G
  250.           XmNbackground                   XmCBackground                   Pixel            dynamic                CSG
  251.           XmNbackgroundPixmap             XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  252.           XmNborderColor                  XmCBorderColor                  Pixel            XtDefaultForeground    CSG
  253.           XmNborderPixmap                 XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  254.           XmNborderWidth                  XmCBorderWidth                  Dimension        0                      CSG
  255.           XmNcolormap                     XmCColormap                     Colormap         dynamic                CG
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 10/3/02)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwww((((3333XXXX))))          UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV          XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwww((((3333XXXX))))
  269.  
  270.  
  271.  
  272.           XmNdepth                        XmCDepth                        int              dynamic                CG
  273.           XmNdestroyCallback              XmCCallback                     XtCallbackList   NULL                   C
  274.           XmNheight                       XmCHeight                       Dimension        dynamic                CSG
  275.           XmNinitialResourcesPersistent   XmCInitialResourcesPersistent   Boolean          True                   C
  276.           XmNmappedWhenManaged            XmCMappedWhenManaged            Boolean          True                   CSG
  277.           XmNscreen                       XmCScreen                       Screen *         dynamic                CG
  278.           XmNsensitive                    XmCSensitive                    Boolean          True                   CSG
  279.           XmNtranslations                 XmCTranslations                 XtTranslations   dynamic                CSG
  280.           XmNwidth                        XmCWidth                        Dimension        dynamic                CSG
  281.           XmNx                            XmCPosition                     Position         0                      CSG
  282.           XmNy                            XmCPosition                     Position         0                      CSG
  283.  
  284.         TTTTrrrraaaannnnssssllllaaaattttiiiioooonnnnssss
  285.           MainWindow inherits translations from ScrolledWindow.
  286.  
  287.      RRRREEEELLLLAAAATTTTEEEEDDDD
  288.           CCCCoooommmmppppoooossssiiiitttteeee(3), CCCCoooonnnnssssttttrrrraaaaiiiinnnntttt(3), CCCCoooorrrreeee(3), XXXXmmmmCCCCrrrreeeeaaaatttteeeeMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwww(3),
  289.           XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwwwSSSSeeeepppp1111(3), XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwwwSSSSeeeepppp2222(3),
  290.           XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwwwSSSSeeeepppp3333(3), XXXXmmmmMMMMaaaaiiiinnnnWWWWiiiinnnnddddoooowwwwSSSSeeeettttAAAArrrreeeeaaaassss(3), XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr(3),
  291.           and XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww(3)
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.      Page 5                                          (printed 10/3/02)
  328.  
  329.  
  330.  
  331.